Skip to content

Retrieve single segment folder

Request

Retrieve a single segment folder based on a parent segment identifier.

Security
TdApikeyAuth
Path
audienceIdinteger, (int64)required

Master segment ID

folderIdinteger, (int64)required

Segment Folder ID

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/folders/{folderId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Retrieves a single segment folder.

N.B. that createdAt can be null, meaning that it is not known which user created the folder.

N.B. that updatedAt can be null, meaning that is is not known which user last updated the folder.

Bodyapplication/json
idstring[1-9][0-9]*
audienceIdstring[1-9][0-9]*

ID of the parent audience. For composable folders this carries the composable audience id; the complete-vs-composable discriminator lives on the parent audience entity, not on the folder.

namestring
descriptionstring or null
createdAtstring, (date-time)
updatedAtstring, (date-time)
createdByUser (object) or (NullValue (object or null))
One of:
updatedByUser (object) or (NullValue (object or null))
One of:
Response
{ "id": "string", "audienceId": "string", "name": "string", "description": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "createdBy": { "id": "string", "td_user_id": "string", "name": "string" }, "updatedBy": { "id": "string", "td_user_id": "string", "name": "string" } }